﻿#region Copyright and License Notice
// Copyright (C)2010-2016 - Rob Levine and other contributors
// http://configgen.codeplex.com
// 
// This file is part of ConfigGen.
// 
// ConfigGen is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// ConfigGen is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License and 
// the GNU Lesser General Public License along with ConfigGen.  
// If not, see <http://www.gnu.org/licenses/>
#endregion
namespace ConfigGen.Core.SettingsLoader
{
    /// <summary>
    /// Spreadsheet preferences which dictate how the spreadsheet is parsed.
    /// </summary>
    public class SpreadsheetPreferences
    {
        /// <summary>
        /// Gets or sets the number of columns to skip when parsing the spreadsheet. Default: 2.
        /// </summary>
        public int NumColumnsToSkip { get; set; }

        /// <summary>
        /// Gets or sets the string used to signify an empty string setting (or null to indicate a blank cell). Default: [EmptyString].
        /// </summary>
        public string EmptyStringPlaceholder { get; set; }

        /// <summary>
        /// Gets or sets the string used to signify an null (missing) setting (or null to indicate a blank cell). Default: null.
        /// </summary>
        public string NullPlaceholder { get; set; }

        /// <summary>
        /// Returns the default preferences.
        /// </summary>
        /// <returns>Default preferences.</returns>
        public static SpreadsheetPreferences GetDefaultPreferences()
        {
            return new SpreadsheetPreferences
                       {
                           EmptyStringPlaceholder = "[EmptyString]",
                           NullPlaceholder = string.Empty,
                           NumColumnsToSkip = 2
                       };
        }
    }
}
